Player

open class Player

A class to control and observe audio/video content.

Types

Companion

object Companion

The Player companion class.

Functions

disconnect

fun disconnect()

Disconnects the player from the PlayerStreamer service.

pause

fun pause()

Pauses playback and the player transitions to PlayerState.IDLE.

play

fun play()

Starts or resumes playback of the current stream.

toString

open override fun toString(): String

Returns a string representation of the Player

Properties

availableQualities

val availableQualities: List<PlayerQuality>

A list of qualities from a stream.

isMuted

var isMuted: Boolean

The audio-muting state of the player.

liveLatency

val liveLatency: Long

For a live stream, the latency to the source.

playerView

var playerView: PlayerView? = null

A view that renders Player media content.

position

val position: Long

The playback position.

quality

var quality: PlayerQuality

Quality of the stream.

state

var state: PlayerState

The player state.

stats

val stats: PlayerStats

The media statistics of the Player's live stream.

streamerSid

val streamerSid: String

The PlayerStreamer SID.

videoSize

var videoSize: VideoDimensions

Native size of the current video source, in pixels.

volume

var volume: Float = 1.0f

Output gain of the audio track.